Document that submodules must be updated after switching branches Switching between master and stable-2.8 with `git checkout` will break the build if the submodules are not also updated. Mention this in the documentation. Change-Id: Id850172b9e23c9c7b9d4d73aea82daf136679166
diff --git a/Documentation/dev-readme.txt b/Documentation/dev-readme.txt index e73e039..10455c0 100644 --- a/Documentation/dev-readme.txt +++ b/Documentation/dev-readme.txt
@@ -28,6 +28,23 @@ link:dev-buck.html#build[Building on the command line with Buck]. +Switching between branches +-------------------------- + +When switching between branches with `git checkout`, be aware that +submodule revisions are not altered. This may result in the wrong +plugin revisions being present, unneeded plugins being present, or +expected plugins being missing. + +After switching branches, make sure the submodules are at the correct +revisions for the new branch with the commands: + +---- + git submodule update + git clean -fdx +---- + + Configuring Eclipse -------------------